Skip to main content

Commenting conventions

  • Don’t prefer to use comments. If it is required, then follow the steps below.
  • Place the comment on a separate line, not at the end of a line of code.
  • Begin comment text with an uppercase letter.
  • End comment text with a period.
  • Insert one space between the comment delimiter (//) and the comment text, as shown in the following example.
// The following declaration creates a query. It does not run
// the query.
  • Don't create formatted blocks of asterisks around comments.